home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3n / t_rcvudata.z / t_rcvudata
Encoding:
Text File  |  2002-10-03  |  10.0 KB  |  133 lines
  1.  
  2.  
  3.  
  4. tttt____rrrrccccvvvvuuuuddddaaaattttaaaa((((3333NNNN))))                                                  tttt____rrrrccccvvvvuuuuddddaaaattttaaaa((((3333NNNN))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _tttt______rrrr_cccc_vvvv_uuuu_dddd_aaaa_tttt_aaaa - receive a data unit
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_ffff_dddd_eeee_ffff ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_xxxx_tttt_iiii_...._hhhh_>>>>
  14.      _####_eeee_llll_ssss_eeee
  15.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_tttt_iiii_uuuu_ssss_eeee_rrrr_...._hhhh_>>>>
  16.      _####_eeee_nnnn_dddd_iiii_ffff
  17.  
  18.      _iiii_nnnn_tttt _tttt______rrrr_cccc_vvvv_uuuu_dddd_aaaa_tttt_aaaa _((((_iiii_nnnn_tttt _ffff_dddd_,,,, _ssss_tttt_rrrr_uuuu_cccc_tttt _tttt______uuuu_nnnn_iiii_tttt_dddd_aaaa_tttt_aaaa _****_uuuu_nnnn_iiii_tttt_dddd_aaaa_tttt_aaaa_,,,, _iiii_nnnn_tttt _****_ffff_llll_aaaa_gggg_ssss_))))_;;;;
  19.  
  20. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      This function is used in connectionless mode to receive a data unit from
  22.      another transport user.  _ffff_dddd identifies the local transport endpoint
  23.      through which data will be received, _uuuu_nnnn_iiii_tttt_dddd_aaaa_tttt_aaaa holds information
  24.      associated with the received data unit, and _ffff_llll_aaaa_gggg_ssss is set on return to
  25.      indicate that the complete data unit was not received.  _uuuu_nnnn_iiii_tttt_dddd_aaaa_tttt_aaaa points
  26.      to a _tttt______uuuu_nnnn_iiii_tttt_dddd_aaaa_tttt_aaaa structure containing the following members:
  27.  
  28.           _ssss_tttt_rrrr_uuuu_cccc_tttt _nnnn_eeee_tttt_bbbb_uuuu_ffff _aaaa_dddd_dddd_rrrr_;;;;
  29.           _ssss_tttt_rrrr_uuuu_cccc_tttt _nnnn_eeee_tttt_bbbb_uuuu_ffff _oooo_pppp_tttt_;;;;
  30.           _ssss_tttt_rrrr_uuuu_cccc_tttt _nnnn_eeee_tttt_bbbb_uuuu_ffff _uuuu_dddd_aaaa_tttt_aaaa_;;;;
  31.  
  32.      The _mmmm_aaaa_xxxx_llll_eeee_nnnn [see _nnnn_eeee_tttt_bbbb_uuuu_ffff in _iiii_nnnn_tttt_rrrr_oooo(3N)] field of _aaaa_dddd_dddd_rrrr, _oooo_pppp_tttt, and _uuuu_dddd_aaaa_tttt_aaaa must
  33.      be set before issuing this function to indicate the maximum size of the
  34.      buffer for each.
  35.  
  36.      On return from this call, _aaaa_dddd_dddd_rrrr specifies the protocol address of the
  37.      sending user, _oooo_pppp_tttt identifies protocol-specific options that were
  38.      associated with this data unit, and _uuuu_dddd_aaaa_tttt_aaaa specifies the user data that
  39.      was received.
  40.  
  41.      By default, _tttt______rrrr_cccc_vvvv_uuuu_dddd_aaaa_tttt_aaaa operates in synchronous mode and will wait for a
  42.      data unit to arrive if none is currently available.  However, if _OOOO______NNNN_DDDD_EEEE_LLLL_AAAA_YYYY
  43.      or _OOOO______NNNN_OOOO_NNNN_BBBB_LLLL_OOOO_CCCC_KKKK is set (via _tttt______oooo_pppp_eeee_nnnn or _ffff_cccc_nnnn_tttt_llll), _tttt______rrrr_cccc_vvvv_uuuu_dddd_aaaa_tttt_aaaa will execute in
  44.      asynchronous mode and will fail if no data units are available.
  45.  
  46.      If the buffer defined in the _uuuu_dddd_aaaa_tttt_aaaa field of _uuuu_nnnn_iiii_tttt_dddd_aaaa_tttt_aaaa is not large enough
  47.      to hold the current data unit, the buffer will be filled and _TTTT______MMMM_OOOO_RRRR_EEEE will
  48.      be set in _ffff_llll_aaaa_gggg_ssss on return to indicate that another _tttt______rrrr_cccc_vvvv_uuuu_dddd_aaaa_tttt_aaaa should be
  49.      issued to retrieve the rest of the data unit.  Subsequent _tttt______rrrr_cccc_vvvv_uuuu_dddd_aaaa_tttt_aaaa
  50.      call(s) will return zero for the length of the address and options until
  51.      the full data unit has been received.
  52.  
  53.      This function resides within both the X/Open compliant _llll_iiii_bbbb_xxxx_nnnn_eeee_tttt and the
  54.      SVR4 compliant _llll_iiii_bbbb_nnnn_ssss_llll Network Services libraries.  Network Services
  55.      applications which require X/Open compliance must link-load with _----_llll_xxxx_nnnn_eeee_tttt.
  56.      Network Services applications which require SVR4 compliance must link-
  57.      load with _----_llll_nnnn_ssss_llll.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. tttt____rrrrccccvvvvuuuuddddaaaattttaaaa((((3333NNNN))))                                                  tttt____rrrrccccvvvvuuuuddddaaaattttaaaa((((3333NNNN))))
  71.  
  72.  
  73.  
  74.      On failure, _tttt______eeee_rrrr_rrrr_nnnn_oooo may be set to one of the following:
  75.  
  76.      _TTTT_BBBB_AAAA_DDDD_FFFF               The specified file descriptor does not refer to a
  77.                          transport endpoint.
  78.  
  79.      _TTTT_NNNN_OOOO_DDDD_AAAA_TTTT_AAAA             _OOOO______NNNN_DDDD_EEEE_LLLL_AAAA_YYYY or _OOOO______NNNN_OOOO_NNNN_BBBB_LLLL_OOOO_CCCC_KKKK was set, but no data units are
  80.                          currently available from the transport provider.
  81.  
  82.      _TTTT_BBBB_UUUU_FFFF_OOOO_VVVV_FFFF_LLLL_WWWW           There are two different conditions in which _TTTT_BBBB_UUUU_FFFF_OOOO_VVVV_FFFF_LLLL_WWWW
  83.                          will be returned.  If ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE is defined _aaaa_nnnn_dddd
  84.                          the number of bytes allocated for incoming data is
  85.                          _gggg_rrrr_eeee_aaaa_tttt_eeee_rrrr _tttt_hhhh_aaaa_nnnn _zzzz_eeee_rrrr_oooo _aaaa_nnnn_dddd is not sufficient to store the
  86.                          data.  If ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE is _nnnn_oooo_tttt defined and the number
  87.                          of bytes allocated for incoming data is not
  88.                          sufficient to store the data.  The unit data
  89.                          information to be returned in _uuuu_nnnn_iiii_tttt_dddd_aaaa_tttt_aaaa will be
  90.                          discarded.
  91.  
  92.      _TTTT_LLLL_OOOO_OOOO_KKKK               An asynchronous event has occurred on this transport
  93.                          endpoint and requires immediate attention.
  94.  
  95.      _TTTT_NNNN_OOOO_TTTT_SSSS_UUUU_PPPP_PPPP_OOOO_RRRR_TTTT         This function is not supported by the underlying
  96.                          transport provider.
  97.  
  98.      _TTTT_OOOO_UUUU_TTTT_SSSS_TTTT_AAAA_TTTT_EEEE           If ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE is defined and _tttt______rrrr_cccc_vvvv_uuuu_dddd_aaaa_tttt_aaaa() is
  99.                          issued in the wrong sequence on the transport
  100.                          endpoint referenced by _ffff_dddd, the _TTTT_OOOO_UUUU_TTTT_SSSS_TTTT_AAAA_TTTT_EEEE error value
  101.                          is returned within the variable _tttt______eeee_rrrr_rrrr_nnnn_oooo.
  102.  
  103.      _TTTT_SSSS_YYYY_SSSS_EEEE_RRRR_RRRR             A system error has occurred during execution of this
  104.                          function.
  105.  
  106. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  107.      _iiii_nnnn_tttt_rrrr_oooo(3N), _ffff_cccc_nnnn_tttt_llll_((((_2222_))))_,,,, _tttt______aaaa_llll_llll_oooo_cccc_((((_3333_NNNN_))))_,,,, _tttt______oooo_pppp_eeee_nnnn_((((_3333_NNNN_))))_,,,, _tttt______rrrr_cccc_vvvv_uuuu_dddd_eeee_rrrr_rrrr_((((_3333_NNNN_))))_,,,,
  108.      _tttt______ssss_nnnn_dddd_uuuu_dddd_aaaa_tttt_aaaa_((((_3333_NNNN_))))
  109.  
  110. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  111.      _tttt______rrrr_cccc_vvvv_uuuu_dddd_aaaa_tttt_aaaa returns 0 on successful completion and -1 on failure and
  112.      _tttt______eeee_rrrr_rrrr_nnnn_oooo is set to indicate the error.
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.